Skip to content

Feat/delegator shares filters #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 17, 2025
Merged

Feat/delegator shares filters #28

merged 4 commits into from
Jan 17, 2025

Conversation

ccamel
Copy link
Member

@ccamel ccamel commented Jan 17, 2025

Introduce two new CLI flags, --min-shares and --max-shares, to enhance delegators extraction by allowing filtering based on share amounts.

@ccamel ccamel self-assigned this Jan 17, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 17, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces enhancements to the delegators extraction functionality across multiple files. The changes primarily focus on improving the delegatorsReader with new configuration options, adding filtering capabilities for delegator shares, and refactoring the code to be more modular and flexible. The modifications span command-line interface improvements, logging configuration, and backend processing logic for delegator information extraction.

Changes

File Change Summary
cmd/delegators.go - Added flagMinShares and flagMaxShares flags
- Introduced newDelegatorsReader() helper function
- Added getShares() function for flag value processing
cmd/extract.go - Minor capitalization updates to flag help text
cmd/root.go - Changed default log level from "info" to "warn"
cmd/version.go - Updated flag descriptions with lowercase first letters
pkg/delegators/enhancer.go - Refactored key formatting using lo.Map()
- Changed key string format from hyphen to underscore
pkg/delegators/reader.go - Added new functional options for delegatorsReader
- Introduced min/max shares filtering
- Refactored delegation processing logic
- Added helper functions extractDelegations() and computeShares()

Sequence Diagram

sequenceDiagram
    participant CLI as Command Line Interface
    participant Reader as DelegatorsReader
    participant Staking as StakingKeeper
    participant Bank as BankKeeper

    CLI->>Reader: Configure with options
    Reader->>Reader: Set chain name, logger
    Reader->>Reader: Apply min/max shares filter
    Reader->>Bank: Iterate all addresses
    Bank-->>Reader: Return addresses
    Reader->>Staking: Extract delegations
    Staking-->>Reader: Return delegations
    Reader->>Reader: Filter and compute shares
    Reader->>CLI: Return processed delegator data
Loading

The sequence diagram illustrates the enhanced delegator extraction process, showing how the new configuration options and filtering mechanisms are integrated into the workflow.

Possibly related PRs

  • docs(cli): improve code documentation #32: The changes in this PR involve the extractDelegatorsCmd command in cmd/delegators.go, which is directly related to the modifications made in the main PR regarding the extractDelegatorsCmd command and the addition of the flagMinShares and flagMaxShares flags.
  • perf(delegators): significantly improve extraction performance #36: This PR modifies the pkg/delegators/reader.go file, which is relevant to the main PR as it introduces a new helper function newDelegatorsReader that interacts with the delegatorsReader structure, enhancing the overall functionality related to delegator extraction.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 72c601a and d4900c6.

⛔ Files ignored due to path filters (2)
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum, !**/*.sum
📒 Files selected for processing (6)
  • cmd/delegators.go (2 hunks)
  • cmd/extract.go (1 hunks)
  • cmd/root.go (1 hunks)
  • cmd/version.go (1 hunks)
  • pkg/delegators/enhancer.go (2 hunks)
  • pkg/delegators/reader.go (4 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ccamel ccamel merged commit 07152e0 into main Jan 17, 2025
12 checks passed
@ccamel ccamel deleted the feat/delegator-shares-filters branch January 17, 2025 17:25
@bot-anik
Copy link
Member

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@ccamel ccamel

Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ccamel @bot-anik